

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Define Tasks Pane Toolboxes [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Tasks Pane,Tasks Pane Toolboxes, Define,Toolbox,Toolbox Tasks Pane, Define">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Define Tasks Pane Toolboxes</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="custom_task_panes.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="built_in_task_pane_commands.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">A </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText"> toolbox is defined by a </span><span class="f_BodyText">&laquo;</span><span class="f_BodyText" style="font-style: italic;">stereotype</span><span class="f_BodyText">&raquo;</span><span class="f_BodyText"> Class that extends a </span><span class="f_BodyText">&laquo;</span><span class="f_BodyText" style="font-style: italic;">metaclass</span><span class="f_BodyText">&raquo;</span><span class="f_BodyText">ToolboxPage element. These elements must be owned by a </span><span class="f_BodyText">&laquo;</span><span class="f_BodyText" style="font-style: italic;">profile</span><span class="f_BodyText">&raquo;</span><span class="f_BodyText"> package. Each </span><span class="f_BodyText">&laquo;</span><span class="f_BodyText" style="font-style: italic;">stereotype</span><span class="f_BodyText">&raquo;</span><span class="f_BodyText"> Class represents the contents of the </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText"> for a given context, and each attribute of the </span><span class="f_BodyText">&laquo;</span><span class="f_BodyText" style="font-style: italic;">stereotype</span><span class="f_BodyText">&raquo;</span><span class="f_BodyText"> Class defines a command button in the </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText">. The following diagram shows an example of a </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText"> toolbox.</span></p>
<p class="p_TextIndentedL2"><img src="example%20of%20taskpane%20toolbox%20diagram.png" width="670" height="332" border="0" alt="Example Of TaskPane Toolbox Diagram"></p>
<p class="p_BodyText"><span class="f_BodyText">The title bar of the </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText"> toolbox is defined by the Alias of the </span><span class="f_BodyText">&laquo;</span><span class="f_BodyText" style="font-style: italic;">stereotype</span><span class="f_BodyText">&raquo;</span><span class="f_BodyText"> Class, in this case </span><span class="f_BodyText" style="font-style: italic;">Debugging Profile</span><span class="f_BodyText">. This example uses the following standard attribute types:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1" style="font-weight: bold;">EASystem::MenuCmd</span><span class="f_Bulletlist1">. These entries name an Enterprise Architect main menu command inside round brackets. </span><span class="f_BodyText">See the</span><span class="f_Bulletlist1"> complete <a href="built_in_task_pane_commands.htm">list of inbuilt commands</a>. Type the text to appear in the </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText"> </span><span class="f_Bulletlist1">into the</span><span class="f_BodyText"> </span><span class="f_MenuKeyField">Initial Value</span><span class="f_BodyText"> </span><span class="f_Bulletlist1">field</span><span class="f_BodyText">.</span></li>
<li><span class="f_Bulletlist1" style="font-weight: bold;">EASystem::ShowHelp</span><span class="f_Bulletlist1">. These entries name a page from the </span><span class="f_Bulletlist1" style="font-style: italic;">Enterprise Architect User Guide</span><span class="f_Bulletlist1"> inside round brackets. To find out the names of pages in the </span><span class="f_Bulletlist1" style="font-style: italic;">Enterprise Architect User Guide</span><span class="f_Bulletlist1">, right-click the page and select the </span><span class="f_MenuKeyField">Properties</span><span class="f_Bulletlist1"> menu option.</span><span class="f_BodyText"> </span><span class="f_Bulletlist1">Type the text to appear in the</span><span class="f_BodyText"> </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText"> </span><span class="f_Bulletlist1">into the </span><span class="f_MenuKeyField">Initial Value</span><span class="f_Bulletlist1"> field</span><span class="f_BodyText">.</span></li>
<li><span class="f_Bulletlist1" style="font-weight: bold;">EASystem::ShowMovie</span><span class="f_Bulletlist1">. These entries give the URL of a movie inside round brackets.</span><span class="f_BodyText"> </span><span class="f_Bulletlist1">Type the text to appear in the</span><span class="f_BodyText"> </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText"> </span><span class="f_Bulletlist1">into the</span><span class="f_BodyText"> </span><span class="f_MenuKeyField">Initial Value</span><span class="f_Bulletlist1"> field</span><span class="f_BodyText">.</span></li>
<li><span class="f_Bulletlist1" style="font-weight: bold;">SEPARATOR</span><span class="f_Bulletlist1">. This entry indicates that a separator should be placed in the </span><span class="f_UIControl">Tasks Pane</span><span class="f_Bulletlist1"> toolbox. If it is necessary to place multiple separators in a single toolbox, note that Enterprise Architect does not allow identically named attributes for a Class: simply change the case of one or more letters to get around the problem.</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">Other useful attributes include:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1" style="font-weight: bold;">EASystem::ShowURL</span><span class="f_Bulletlist1">. This </span><span class="f_Bulletlist1">entry gives the URL of a web page inside round brackets. Type the text to appear in the </span><span class="f_UIControl">Tasks Pane</span><span class="f_Bulletlist1"> into the</span><span class="f_Bulletlist1" style="font-weight: bold;"> Initial Value</span><span class="f_Bulletlist1"> field. </span></li>
<li><span class="f_Bulletlist1" style="font-weight: bold;">isCommon:</span><span class="f_Bulletlist1"> A boolean attribute with </span><span class="f_MenuKeyField">Initial Value</span><span class="f_Bulletlist1"> set to </span><span class="f_MenuKeyField">True,</span><span class="f_Bulletlist1"> defines a </span><span class="f_UIControl">Tasks Pane</span><span class="f_Bulletlist1"> toolbox as context-free and common, appearing for all contexts</span></li>
<li><span class="f_Bulletlist1">You can also <a href="run_add_in_functions_from_task.htm">run Add-In functions</a> from the </span><span class="f_UIControl">Tasks Pane</span><span class="f_Bulletlist1">.</span></li>
</ul>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Next Step</span></p>
<p class="p_BodyText"><span class="f_BodyText">The next step is to create a set of <a href="define_task_pane_contexts.htm">Tasks Pane Contexts</a>.</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
